<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>RssGmailClient xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/com/googlecode/gmail4j/rss/RssGmailClient.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright (c) 2008-2009 Tomas Varaneckas</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * <a href="http://www.varaneckas.com" target="alexandria_uri">http://www.varaneckas.com</a></em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * </em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * This program is free software: you can redistribute it and/or modify</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * it under the terms of the GNU General Public License as published by</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * the Free Software Foundation, either version 3 of the License, or</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * (at your option) any later version.</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> * </em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * This program is distributed in the hope that it will be useful,</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * GNU General Public License for more details.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * </em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * You should have received a copy of the GNU General Public License</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * along with this program. If not, see &lt;<a href="http://www.gnu.org/licenses/&gt;." target="alexandria_uri">http://www.gnu.org/licenses/&gt;.</a></em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> com.googlecode.gmail4j.rss;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.net.Authenticator;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.GmailClient;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.GmailException;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.GmailMessage;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.auth.Credentials;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gmail4j.auth.GmailHttpAuthenticator;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> com.sun.syndication.feed.synd.SyndEntry;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> com.sun.syndication.feed.synd.SyndFeed;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> com.sun.syndication.io.SyndFeedInput;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> com.sun.syndication.io.XmlReader;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * Gmail RSS feed based {@link GmailClient} implementation.</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * Functionality is limited to unread message retrieval.</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * Example use:</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> *     GmailClient client = new RssGmailClient();</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> *     client.setLoginCredentials(new Credentials("user", "pass".toCharArray()));</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> *     client.init();</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> *     for (GmailMessage message : client.getUnreadMessages()) {</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> *         System.out.println(message.getFrom() + ": " + message.getTitle());</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> *     }</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;&lt;/blockquote&gt;</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * </em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * @see RssGmailMessage</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * @see GmailClient</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * @see Credentials</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * @author Tomas Varaneckas &amp;lt;tomas.varaneckas@gmail.com&amp;gt;</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * @version $Id: RssGmailClient.java 11 2009-03-20 12:31:30Z tomas.varaneckas $</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * @since 0.1</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> */</em>
<a name="57" href="#57">57</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../com/googlecode/gmail4j/rss/RssGmailClient.html">RssGmailClient</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../com/googlecode/gmail4j/GmailClient.html">GmailClient</a> {
<a name="58" href="#58">58</a>      
<a name="59" href="#59">59</a>      <em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * Gmail feed URL. It should remain as is, however you can set a new value.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * </em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * @see #setGmailFeedUrl(String)</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     */</em>
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">private</strong> String gmailFeedUrl = <span class="jxr_string">"https://mail.google.com/mail/feed/atom"</span>;
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      @Override
<a name="67" href="#67">67</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() {
<a name="68" href="#68">68</a>          loginCredentials.validate();
<a name="69" href="#69">69</a>          Authenticator.setDefault(<strong class="jxr_keyword">new</strong> <a href="../../../../com/googlecode/gmail4j/auth/GmailHttpAuthenticator.html">GmailHttpAuthenticator</a>(loginCredentials));
<a name="70" href="#70">70</a>      }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>      <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * Gets {@link #gmailFeedUrl}</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     * </em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * @return Gmail feed URL</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     */</em>
<a name="77" href="#77">77</a>      <strong class="jxr_keyword">public</strong> String getGmailFeedUrl() {
<a name="78" href="#78">78</a>          <strong class="jxr_keyword">return</strong> gmailFeedUrl;
<a name="79" href="#79">79</a>      }
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <em class="jxr_javadoccomment">/**</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * Sets {@link #gmailFeedUrl}</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * Use it only if you would like to use another Gmail feed URL than the </em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * default &lt;a href="https://mail.google.com/mail/feed/atom"&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * https://mail.google.com/mail/feed/atom&lt;/a&gt;.</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * </em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     * @param gmailFeedUrl New Gmail feed URL</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     */</em>
<a name="90" href="#90">90</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setGmailFeedUrl(<strong class="jxr_keyword">final</strong> String gmailFeedUrl) {
<a name="91" href="#91">91</a>          <strong class="jxr_keyword">this</strong>.gmailFeedUrl = gmailFeedUrl;
<a name="92" href="#92">92</a>      }
<a name="93" href="#93">93</a>      
<a name="94" href="#94">94</a>      @Override
<a name="95" href="#95">95</a>      <strong class="jxr_keyword">public</strong> List&lt;GmailMessage&gt; getUnreadMessages() {
<a name="96" href="#96">96</a>          <strong class="jxr_keyword">final</strong> List&lt;GmailMessage&gt; messages = <strong class="jxr_keyword">new</strong> ArrayList&lt;GmailMessage&gt;();
<a name="97" href="#97">97</a>          <strong class="jxr_keyword">try</strong> {
<a name="98" href="#98">98</a>              <strong class="jxr_keyword">final</strong> URL feedSource = <strong class="jxr_keyword">new</strong> URL(gmailFeedUrl);
<a name="99" href="#99">99</a>              <strong class="jxr_keyword">final</strong> SyndFeedInput feedInput = <strong class="jxr_keyword">new</strong> SyndFeedInput();
<a name="100" href="#100">100</a>             <strong class="jxr_keyword">final</strong> SyndFeed gmail = feedInput.build(<strong class="jxr_keyword">new</strong> XmlReader(feedSource));
<a name="101" href="#101">101</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Object entry : gmail.getEntries()) {
<a name="102" href="#102">102</a>                 <strong class="jxr_keyword">if</strong> (entry instanceof SyndEntry) {
<a name="103" href="#103">103</a>                     messages.add(<strong class="jxr_keyword">new</strong> <a href="../../../../com/googlecode/gmail4j/rss/RssGmailMessage.html">RssGmailMessage</a>((SyndEntry) entry));
<a name="104" href="#104">104</a>                 }
<a name="105" href="#105">105</a>             }
<a name="106" href="#106">106</a>             <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a name="107" href="#107">107</a>                 log.debug(<span class="jxr_string">"Got "</span> + messages.size() + <span class="jxr_string">" new messages."</span>);
<a name="108" href="#108">108</a>             }
<a name="109" href="#109">109</a>         } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) {
<a name="110" href="#110">110</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../com/googlecode/gmail4j/GmailException.html">GmailException</a>(<span class="jxr_string">"Failed getting unread messages"</span>, e);
<a name="111" href="#111">111</a>         }
<a name="112" href="#112">112</a>         <strong class="jxr_keyword">return</strong> messages;
<a name="113" href="#113">113</a>     }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     @Override
<a name="116" href="#116">116</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> finalize() <strong class="jxr_keyword">throws</strong> Throwable {
<a name="117" href="#117">117</a>         loginCredentials.dispose();
<a name="118" href="#118">118</a>         <strong class="jxr_keyword">super</strong>.finalize();
<a name="119" href="#119">119</a>     }
<a name="120" href="#120">120</a>     
<a name="121" href="#121">121</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

